errors: don't print an empty line for Exit with empty message#2312
Open
alliasgher wants to merge 2 commits intourfave:mainfrom
Open
errors: don't print an empty line for Exit with empty message#2312alliasgher wants to merge 2 commits intourfave:mainfrom
alliasgher wants to merge 2 commits intourfave:mainfrom
Conversation
3 tasks
When HandleExitCoder received an ExitCoder whose Error() returned an
empty string (e.g. cli.Exit("", code)), it still called
fmt.Fprintln(ErrWriter, err) which wrote a bare newline to stderr.
Guard the print with a check on the error message so that an empty
message produces no output at all.
Fixes urfave#2263
Signed-off-by: alliasgher <alliasgher123@gmail.com>
Adds TestHandleExitCoder_ErrorFormatterDirect to exercise the Fprintf branch in HandleExitCoder when an ExitCoder also implements ErrorFormatter and is passed in directly. The existing TestHandleExitCoder_ErrorFormatter routes through a multiError which goes down a different branch, so the direct path was not hit by any test (codecov patch). Signed-off-by: alliasgher <alliasgher123@gmail.com>
alliasgher
force-pushed
the
fix-exit-empty-message-stderr
branch
from
6463da2 to
5f284b8
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
When
cli.Exit("", exitCode)is called,HandleExitCoderstill wrote a bare newline toErrWriter(usually stderr), because it calledfmt.Fprintln(ErrWriter, err)unconditionally. AnExitCoderwith an empty message should produce no output.Before
After
Fix
Guard the
fmt.Fprintln/fmt.Fprintfcalls with a check thaterr.Error() != ""before writing toErrWriter.Fixes #2263
Checklist
TestHandleExitCoder_EmptyMessage)